-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update swagger docs with declaration endpoints #1504
Update swagger docs with declaration endpoints #1504
Conversation
0c458ac
to
f923fad
Compare
spec/support/shared_examples/api_create_on_resource_endpoint_documentation_support.rb
Show resolved
Hide resolved
spec/swagger_schemas/requests/participant_declaration_completed_request.rb
Show resolved
Hide resolved
5aa4ff6
to
c871d86
Compare
9b01e9e
to
f5275af
Compare
Review app deployed to https://npq-registration-review-1504-web.test.teacherservices.cloud/ |
8d5c34e
to
82e7d2c
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressed a very small thing and approved 👍 😄 tks guys
it_behaves_like "an API update endpoint documentation", | ||
"/api/v1/participant-declarations/{id}/void", | ||
"Participant declarations", | ||
"Void a declaration", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could voided declarations have examples returned with voided state?
} | ||
h[:v3][:properties][:attributes][:properties][:lead_provider_name] = { | ||
description: "The name of the provider that submitted the declaration", | ||
type: "string", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we add an example to lead provider as it's coming up as string
description: "The type of course the participant is enrolled in", | ||
type: :string, | ||
required: true, | ||
enum: %w[ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could we use Course::IDENTIFIERS
and Course::IDENTIFIERS.first
here similar to declarations?
description: "The type of course the participant is enrolled in", | ||
type: :string, | ||
required: true, | ||
enum: %w[ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here and in the completed declaration request?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looking good some more suggestions, also could we ensure that the example is valid, so we don't set the has_passed
to true if the declaration is started or retained?
… correctly for void
ef37705
to
82b3792
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌 thanks Mook
Context
Ticket: https://dfedigital.atlassian.net/browse/CPDLP-3103
Description
Add API docs for all the declaration endpoints in NPQ in v1/v2/v3 for the GET/POST participant-declarations in all versions including any errors as in About the API - Manage training for early career teachers . Add the PUT void declarations in all versions.